Obtains folder routing information from the global routing list.

OSErr GetFolderRoutings (
    UInt32 requestedRoutingCount, 
    UInt32 *totalRoutingCount, 
    Size routingSize, 
    FolderRouting *theRoutings
);

Parameter descriptions

requestedRoutingCount

An unsigned 32-bit value. Pass the number of folder routing structures that can fit in the buffer pointed to by the theRoutings parameter.

totalRoutingCount

A pointer to an unsigned 32-bit value. On return, the value is set to the number of folder routing structures in the global list. If this value is less than or equal to requestedRoutingCount, all folder routing structures were returned to the caller.

routingSize

Pass the size (in bytes) of the FolderRouting structure.

theRoutings

Pass a pointer to an array of FolderRouting structures. On return the structure(s) contain the requested routing information. You may pass null if you do not wish this information.

function result

A result code.

DISCUSSION

The folder routing information in the global routing list determines how the Finder routes files.

VERSION NOTES

Supported under Mac OS 8 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)